Skip to main content
Version: 9.2

Customization Defaults

Defaults

Enables you to set styles and other customizations for the dependent components.

defaults: {
customStyles:{
button: { 'color': '#200606' }
}
}

The following options are available for fontFamily properties.

  • 'Inter, serif'
  • 'Roboto, sans-serif'
  • 'Georgia, serif'
  • 'Palatino Linotype, Book Antiqua, Palatino, serif'
  • 'Times New Roman, Times, serif'
  • 'Arial, Helvetica, sans-serif'
  • 'Arial Black, Gadget, sans-serif'
  • 'Comic Sans MS, cursive, sans-serif'
  • 'Impact, Charcoal, sans-serif'
  • 'Lucida Sans Unicode, Lucida Grande, sans-serif'
  • 'Tahoma, Geneva, sans-serif'
  • 'Trebuchet MS, Helvetica, sans-serif'
  • 'Verdana, Geneva, sans-serif'
  • 'Courier New, Courier, monospace'
  • 'Lucida Console, Monaco, monospace'

The following options are available for defaultValidator and validators properties.

  • EQUALS
  • NOT_EQUAL
  • CONTAINS
  • NOT_CONTAIN
  • ENDS_WITH
  • NOT_END_WITH
  • STARTS_WITH
  • NOT_START_WITH
  • BETWEEN_INCLUSIVE
  • BETWEEN_EXCLUSIVE
  • LESS_THAN
  • LESS_THAN_EQUAL
  • GREATER_THAN
  • GREATER_THAN_EQUAL
  • IS_NULL
  • IS_NOT_NULL
  • BEFORE
  • AFTER
  • BEFORE_ON
  • AFTER_ON
  • IN

List Properties

ViewPropertyTypeDescriptionExample
listassetListViewModestringDefines the default view mode for the asset list."card" or "table"

Text Properties

ViewPropertyTypeDescriptionExample
designcustomStyles.text.alignTextstringDefault align text for the text element."left", "center", "right", or "justify"
designcustomStyles.text.backgroundColorstringDefault background color.'#000000', 'green', 'GREEN'
designcustomStyles.text.borderColorstringDefault border color for the text element.'#000000', 'green', 'GREEN'
designcustomStyles.text.borderStylestringDefault border style."solid", "dotted", "dashed", or "double"
designcustomStyles.text.borderWidthstringDefault border width. Any value between 1-20 pixels"20px"
designcustomStyles.text.fontColorstringDefault font color for the text element'#000000', 'green', 'GREEN'
designcustomStyles.text.fontFamilystringDefault font for the text element.'Lucida Console, Monaco, monospace'
designcustomStyles.text.fontSizestringDefault font size for the text element. Choose from 8, 9, 10, 11, 12, 14, 15, 16, 18, 24, 30, 36, 48, 60, 72, or 96 pixels."96px"
designcustomStyles.text.fontStylebooleanDefault font style for the text element (italic styling).true
designcustomStyles.text.fontWeightbooleanDefault font weight for the text element (bold styling).true
designcustomStyles.text.paddingBottomnumberDefault padding bottom for the text element."20px"
designcustomStyles.text.paddingLeftnumberDefault padding left for the text element."20px"
designcustomStyles.text.paddingRightnumberDefault padding right for the text element."20px"
designcustomStyles.text.paddingTopnumberDefault padding top for the text element."20px"
designcustomStyles.text.strikebooleanDefault strike for the text element.true
designcustomStyles.text.underlinebooleanDefault underline for the text element.true

Image Properties

ViewPropertyTypeDescriptionExample
designcustomStyles.image.aspectstringDefault aspect for image."contain", "cover", or "fill"

Button Properties

ViewPropertyTypeDescriptionExample
designcustomStyles.button.backgroundstringButton background color.'#000000', 'green', 'GREEN'
designcustomStyles.button.colorstringButton font color.'#000000', 'green', 'GREEN'
designcustomStyles.button.fontFamilystringButton font family.'Lucida Console, Monaco, monospace'
designcustomStyles.button.fontSizestringButton font size. Choose from 8, 9, 10, 11, 12, 14, 15, 16, 18, 24, 30, 36, 48, 60, 72, or 96 pixels."96px"
designcustomStyles.button.labelstringText for the element."text"
designcustomStyles.button.urlstringURL for the button select event."www.any-example-url.com"

Header Properties

ViewPropertyTypeDescriptionExample
designcustomStyles.header.layoutWidthstringWidth of the header."screen" or "canvas"
designcustomStyles.header.backgroundColorstringBackground color for the header.'#000000', 'green', 'GREEN'
designcustomStyles.header.heightstringDefault header size. Value should be between 10-300."12"
designcustomStyles.header.backgroundImageConfig.aspectstringDefault aspect for header background image."contain", "cover" or "fill"
designcustomStyles.header.backgroundImageConfig.imagestringBackground image for the header."www.any-example-url.xxx"

Container Properties

ViewPropertyTypeDescriptionExample
designcustomStyles.container.backgroundAspectstringSets the size of the element's background image."contain", "cover" or "fill"
designcustomStyles.container.backgroundColorstringBackground color of the container (color names or hex).'#000000', 'green', 'GREEN'
designcustomStyles.container.borderColorstringBorder color of the container (color names or hex).'#000000', 'green', 'GREEN'
designcustomStyles.container.borderRadiusnumberNumber to round the corners of the container outer border edges.-
designcustomStyles.container.borderStylestringStyle to visualize the border."none", "solid" or "dotted"
designcustomStyles.container.borderWidthnumberWidth of the border style.-
designcustomStyles.container.backgroundImageURLstringBackground image for the container.Valid image URL

Tab Properties

ViewPropertyTypeDescriptionExample
designcustomStyles.tab.backgroundColorstringTabs indicator color.'#000000', 'green', 'GREEN'
designcustomStyles.tab.borderstringTabs border color.'#000000', 'green', 'GREEN'
designcustomStyles.tab.fontColorstringTabs font color.'#000000', 'green', 'GREEN'
designcustomStyles.tab.fontSizestringTabs font size.'8px', '24px'
designcustomStyles.tab.fontTypestringTabs font type.'Lucida Console, Monaco, monospace'
designcustomStyles.tab.generalSizestringDefault size for tabs"20px"
designcustomStyles.tab.namestringLabel for the name of a new tab."My example new label"
designcustomStyles.tab.selectorColorstringSelected tab indicator color.Examples: '#000000', 'green', 'GREEN'
designcustomStyles.tab.widthTypestringTabs definition for width type."MANUAL", "AUTOMATIC", or "SAME_SIZE"

Input Box Properties

ViewPropertyTypeDescriptionExample
designcustomStyles.filterCtrlInputBox.backgroundColorstringBackground color for the filter control (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.borderColorstringBorder color for the filter control (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.buttonBackgroundColorstringBackground color of the apply filter button in the filter control (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.buttonBorderColorstringBorder color of the apply filter button in the filter control (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.buttonTextColorstringText color of the apply filter button in the filter control (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.columnsArrayAn array of columns where the filter is applied.[{ "columnId": "xxxxx", "datasetId": "datasetxxx"}]
designcustomStyles.filterCtrlInputBox.defaultGroupingstringDate Grouping selected by the user in interaction mode. To apply this default, select a column using the “columns” field. If no column is selected through customization, the default is loaded based on the column’s data type. You also have to select a list of valid groupings.'day', 'month', 'year'
designcustomStyles.filterCtrlInputBox.defaultValidatorObjectDefault validator selected for the filter control. To apply this default, select a column using the “columns” field. If no column is selected through customization, the default is loaded based on the column’s data type. You also have to select a list of valid validators. The value of validator should be one of the strings from the list above.'CONTAINS'
designcustomStyles.filterCtrlInputBox.fontColorstringFont color for the filter control label (title) (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.fontFamilystringList of font types for the filter control.'Roboto, sans-serif', 'Arial, Helvetica, sans-serif', 'Lucida Console, Monaco, monospace'
designcustomStyles.filterCtrlInputBox.groupingsArrayDate Grouping list. To apply this default, select a column using the “columns” field. If no column is selected through customization, the default is loaded based on the column’s data type.["day","month","quarter","week","year","quarter_only","month_only","day_only"]
designcustomStyles.filterCtrlInputBox.hintstringPlaceholder text for the filter field.'Enter a value...'
designcustomStyles.filterCtrlInputBox.selectorColorstringColor of the selector checkbox (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlInputBox.titlestringName definition in the filter control, which can be a column name or any text from the panel configuration.Example: 'Column name'
designcustomStyles.filterCtrlInputBox.triggerstringDisplays the Apply Filter button or operates automatically. Two specific values: 'BUTTON' or 'AUTOMATIC'.'AUTOMATIC'
designcustomStyles.filterCtrlInputBox.triggerButtonLabelstringLabel to display text on the apply filter button. Any text string.'Filter'
designcustomStyles.filterCtrlInputBox.validatorsstring[]Object for the validators/operators list. To apply this default, select a column using the “columns” field. If no column is selected through customization, the default is loaded based on the column’s data type. The value of validator should be one of the strings from the list above.["EQUALS","NOT_EQUAL"]

Multiselect List Properties

ViewPropertyTypeDescriptionExample
designcustomStyles.filterCtrlMultiSelectList.backgroundColorstringDefault background color for filter control.'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.borderColorstringBorder color for the filter control.'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.buttonBackgroundColorstringDefault background color for filter buttons.'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.buttonBorderColorstringDefault border color for filter buttons.'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.buttonTextColorstringDefault text color for filter buttons.'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.columnsArrayAn array of columns where the filter is applied. This default requires the fields sourceDataDataset, sourceDataDisplayColumn, and sourceDataValueColumn to be provided through customization to load the data associated.[{ "columnId": "xxxxx", "datasetId": "datasetxxx"}]
designcustomStyles.filterCtrlMultiSelectList.defaultValidatorstringDefault validator/operator to load. The value of validator should be one of the strings from the list above.'EQUALS', 'NOT_EQUAL'
designcustomStyles.filterCtrlMultiSelectList.fontColorstringDefault font color for the filter control label (title).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.fontFamilystringList of font types for filter control.'Lucida Console, Monaco, monospace'
designcustomStyles.filterCtrlMultiSelectList.hintstringDefault placeholder for the input field."any string text"
designcustomStyles.filterCtrlMultiSelectList.selectorColorstringDefault color for the selector checkbox.'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlMultiSelectList.sourceDataDatasetstringID of the dataset used for sourceDataDisplayColumn and sourceDataValueColumn properties. Required if columns is defined."datasetxxx"
designcustomStyles.filterCtrlMultiSelectList.sourceDataDisplayColumnstringColumn ID whose values are shown as display labels in the filter control. Required if columns is defined."displayColumnId"
designcustomStyles.filterCtrlMultiSelectList.sourceDataValueColumnstringColumn ID whose values are used as the actual filter values. Required if columns is defined."valueColumnId"
designcustomStyles.filterCtrlMultiSelectList.titlestringDefines the name in the filter control, which can be a column name or any text from the panel configuration."Column name"
designcustomStyles.filterCtrlMultiSelectList.triggerstringDisplays the Apply Filter button or operates automatically. Two specific values: 'BUTTON' or 'AUTOMATIC'.'BUTTON'
designcustomStyles.filterCtrlMultiSelectList.triggerButtonLabelstringLabel to display the text on the apply filter button"My Label"
designcustomStyles.filterCtrlMultiSelectList.typestringGroups of values.'LIST', 'DROPDOWN'
designcustomStyles.filterCtrlMultiSelectList.validatorsstring[]Object to list the validators/operators. The value of validator should be one of the strings from the list above.['EQUALS', 'NOT_EQUAL']

Date Picker Properties

ViewPropertyTypeDescriptionExample
designcustomStyles.filterCtrlDatePicker.backgroundColorstringBackground color for the filter control (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.borderColorstringBorder color for the filter control (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.buttonBackgroundColorstringBackground color for the apply filter button (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.buttonBorderColorstringBorder color for the filter button (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.buttonTextColorstringText color for the filter button (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.columnsArrayAn array of columns where the filter is applied. The data type of the columns should be date; otherwise, the column is not valid for filtering.[{ "columnId": "xxxxx", "datasetId": "datasetxxx"}]
designcustomStyles.filterCtrlDatePicker.defaultValidatorObjectDefault validator/operator to load. Only date-related validators are valid. The value of validator should be one of the strings from the list above.'AFTER'
designcustomStyles.filterCtrlDatePicker.fontColorstringDefault font color for the filter control label (title) (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.fontFamilystringList of font types for the filter control.'Roboto, sans-serif', 'Arial Black, Gadget, sans-serif', 'Lucida Console, Monaco, monospace'
designcustomStyles.filterCtrlDatePicker.hintstringDefault placeholder text for the filter control.'Enter a date...'
designcustomStyles.filterCtrlDatePicker.selectorColorstringColor of the selector checkbox (color names or hex value).'#000000', 'green', 'GREEN'
designcustomStyles.filterCtrlDatePicker.titlestringDefault name for the filter control.'Column name'
designcustomStyles.filterCtrlDatePicker.triggerstringDefault trigger action, either with a button or automatic mode (on blur).'BUTTON', 'AUTOMATIC'
designcustomStyles.filterCtrlDatePicker.triggerButtonLabelstringDefault text for the Apply Filter button.'Filter'
designcustomStyles.filterCtrlDatePicker.validatorsstring[]Object to list the validators/operators. To apply this default, select a column using the “columns” field. If no column is selected through customization, the default is loaded based on the column’s data type. The value of validator should be one of the strings from the list above.["EQUALS","AFTER"]

Filter Panel Properties

ViewPropertyTypeDescriptionExample
design, preview, enduserfilterPanel.defaultViewstringSets the default state of the filter panel."expanded" or "collapsed"
design, preview, enduserfilterPanel.displayIconBooleanSets the default visibility of the icon option in the filter panel settings.-
design, preview, enduserfilterPanel.displayColorBooleanSets the default visibility of the color option in the filter panel settings.-

End User View Properties

ViewPropertyTypeDescription
enduserendUser.defaults.dragElementBooleanControls dragging elements in the Interact Mode of the dashboard. Default is true.
enduserendUser.defaults.resizeElementBooleanControls resizing elements in the Interact Mode of the dashboard. Default is true.
enduserendUser.defaults.removeElementBooleanControls removing elements in the Interact Mode of the dashboard. Default is true.

Code Sample

customization: {
views: {
endUser: {
defaults: {
dragElement: false,
resizeElement: false,
removeElement: false
}
}
}
}